Skip to content

docs: document JSON output format - #474

Open
efegokdemir wants to merge 2 commits into
NVIDIA:mainfrom
efegokdemir:codex/issue-122-jsonbin-docs
Open

efegokdemir wants to merge 2 commits into
NVIDIA:mainfrom
efegokdemir:codex/issue-122-jsonbin-docs

Conversation

@efegokdemir

Copy link
Copy Markdown
Contributor

Summary

Documents the JSON and --jsonbin output formats requested in #122, including the top-level schema, versioning, benchmark state structure, and binary sidecar files.

Changes

  • Add docs/json_output.md with the JSON structure and --jsonbin sidecar contract.
  • Document version inspection, relative sidecar paths, sample counts, and little-endian float32 encoding.
  • Link the new guide from the --json and --jsonbin CLI help entries.

Testing

  • Documentation content and required-field checks — passed.
  • Internal documentation link checks — passed.
  • git diff --check — passed.

Notes

No open competing PR for #122 was found before implementation. This is a documentation-only change, so CUDA compilation and runtime tests are not applicable. AI assistance was used; the submitting human is responsible for reviewing and understanding every changed line.

Closes #122

Co-authored-by: Codex <codex@openai.com>
Signed-off-by: Efe Gökdemir <efe@rexcode.co.uk>
@copy-pr-bot

copy-pr-bot Bot commented Sep 22, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document jsonbin output format

1 participant